BOT UX API

(0 reviews)

Get PaymentHistory

GET /payment

This operation retrieves a payment history entity

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

http://[localhost]:[port]/bot-ux/v1/{businessId}/payment

Base URI Parameter

Name	Type	Description	M/O
businessId	string	businessId string M Business unit identifier. Example: JM, PA	M

Headers

Name	Type	Description	M/O
Correlation-ID	string	This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b	N
lob	String	The Line of Business Identifier currently available are: Enum: PREPAID, POSTPAID,FIXED Note : Mobile users: PREPAID, POSTPAID Fixed users : FIXED	M
refid	String	The Reference Identifier currently available are: Enum: CUSTOMER_ID, ACCOUNT_NO, SERVICE_NO, RUT_ID TICKETID, RUTID$ACCTID, CONTACT_NO	M
refvalue	String	The Reference Value Ex:265033340000	M

Security Headers

Name	Type	Description	M/O
client_id	string	Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332	M
client_secret	string	Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43fAd324a	M

Query Param

name	type	description	required
paymentMethod.type	string	To retrieve the payments performed with a specific method	N
startDate	datetime	To retrieve the payments performed after this date	N
endDate	datetime	To retrieve the payments performed before this date	N
limit	integer		N
offset	integer		N

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible success response

[200]

OK - payments request processed successfully, response body contains an entity corresponding to the requested resource.

Liberate Response

[
    {
        "id": "549120045",
        "correlatorId": "987654321A",
        "paymentDate": "2023-09-08T06:36:20.000Z",
        "name": "Cisco IVR",
        "description": "UNALLOC",
        "statusDate": "2023-09-08T06:36:20.000Z",
        "taxAmount": {
            "amount": 0.0
        },
        "totalAmount": {
            "amount": 6.10
        },
        "account": {
            "id": "333000660000",
            "name": "110094Automation, 699445QA",
            "description": "Normal"
        },
        "paymentItem": [
            {
                "totalAmount": {
                    "amount": 6.10
                },
                "item": {
                    "referredType": "payment"
                }
            },
            {
                "totalAmount": {
                    "amount": 0.00
                },
                "item": {
                    "referredType": "deposit"
                }
            }
        ],
        "paymentMethod": {
            "@type": "I",
            "details": {
                "type": "S",
                "cardNumber": ""
            }
        }
    },
    {
        "id": "549120044",
        "correlatorId": "987654321A",
        "paymentDate": "2023-09-08T06:34:09.000Z",
        "name": "Cisco IVR",
        "description": "UNALLOC",
        "statusDate": "2023-09-08T06:34:09.000Z",
        "taxAmount": {
            "amount": 0.0
        },
        "totalAmount": {
            "amount": 6.10
        },
        "account": {
            "id": "333000660000",
            "name": "110094Automation, 699445QA",
            "description": "Normal"
        },
        "paymentItem": [
            {
                "totalAmount": {
                    "amount": 6.10
                },
                "item": {
                    "referredType": "payment"
                }
            },
            {
                "totalAmount": {
                    "amount": 0.00
                },
                "item": {
                    "referredType": "deposit"
                }
            }
        ],
        "paymentMethod": {
            "@type": "I",
            "details": {
                "type": "S",
                "cardNumber": ""
            }
        }
    }
]

Cerillion Response

[
    {
        "id": "250248446",
        "correlatorId": "1193651",
        "paymentDate": "2022-12-07T21:54:55.000Z",
        "taxAmount": {
            "amount": "0.0"
        },
        "totalAmount": {
            "amount": "-646.86"
        },
        "account": {
            "id": "47042401"
        },
        "paymentItem": [
            {
                "totalAmount": {
                    "amount": "-646.86"
                },
                "item": {
                    "referredType": "payment"
                }
            }
        ],
        "paymentMethod": {
            "@type": "FIRST CITIZENS BANK CASH"
        }
    },
    {
        "id": "248034178",
        "correlatorId": "1185685",
        "paymentDate": "2022-11-04T16:57:30.000Z",
        "taxAmount": {
            "amount": "0.0"
        },
        "totalAmount": {
            "amount": "-646.86"
        },
        "account": {
            "id": "47042401"
        },
        "paymentItem": [
            {
                "totalAmount": {
                    "amount": "-646.86"
                },
                "item": {
                    "referredType": "payment"
                }
            }
        ],
        "paymentMethod": {
            "@type": "FIRST CITIZENS BANK CASH"
        }
    }
]